fixes(#1283): Add documentation for Multer functions #1284
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IamLizu
reviewed
Dec 26, 2024
|
This adds a lot of changes, in internal methods as well. While the work is appreciated, I suggest changing the PR to DRAFT so that we do not accidentally land it before its ready as there's so much jsDoc to review. cc: @UlisesGascon |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances documentation across Multer by adding detailed JSDoc comments for its storage engines, core middleware, utility classes, and public API methods.
- Added class- and method-level documentation for memory and disk storage engines.
- Documented middleware setup logic, error handling, file appender strategies, and counter utilities.
- Expanded JSDoc on all public Multer APIs (
single,array,fields,none,any) with parameter, return, and example annotations.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| storage/memory.js | Documented MemoryStorage, its _handleFile and _removeFile methods, and the factory export. |
| storage/disk.js | Documented getFilename, getDestination, DiskStorage class, its _handleFile/_removeFile, and factory. |
| lib/remove-uploaded-files.js | Documented removeUploadedFiles signature, callback behavior, and recursive removal logic. |
| lib/multer-error.js | Documented MulterError class, its constructor parameters, and inheritance from Error. |
| lib/make-middleware.js | Documented drainStream, makeMiddleware, and internal helpers (done, indicateDone, abortWithError, abortWithCode). |
| lib/file-appender.js | Documented arrayRemove, FileAppender class, and its placeholder/insertion/removal methods. |
| lib/counter.js | Documented Counter class, its event-driven increment/decrement logic, and onceZero. |
| index.js | Documented allowAll, Multer constructor, _makeMiddleware, wrappedFileFilter, and public methods (single, array, fields, none, any, multer). |
Comments suppressed due to low confidence (5)
storage/memory.js:3
- [nitpick] Consider adding an @constructor or @Class annotation to the JSDoc for MemoryStorage to clearly indicate that it is a constructor function.
function MemoryStorage (opts) {}
storage/disk.js:29
- The
osmodule is referenced here but not imported. Addvar os = require('os')at the top of the file to avoid a ReferenceError.
cb(null, os.tmpdir())
lib/remove-uploaded-files.js:13
- This function implements recursive removal of files and aggregates errors; consider adding unit tests for cases with no files, successful removals, and error aggregation.
function removeUploadedFiles (uploadedFiles, remove, cb) {
lib/multer-error.js:20
- [nitpick] Add an
@extends Errortag in the JSDoc for MulterError to clearly indicate that it inherits from the native Error class.
function MulterError (code, field) {
lib/counter.js:8
- Counter emits a 'zero' event and manages internal state; consider adding tests to verify event emission when reaching zero and correct increment/decrement behavior.
function Counter () {
bjohansebas
reviewed
Jun 2, 2025
| @@ -35,6 +91,33 @@ Multer.prototype._makeMiddleware = function (fields, fileStrategy) { | |||
| } | |||
| }) | |||
|
|
|||
| /** | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Title:
docs: Add documentation for Multer functionsfixes: #1283
#1283
Description:
This pull request adds comprehensive documentation for various Multer functions, improving code readability and helping developers understand the purpose and usage of each function. The following functions have been documented:
allowAllMulter.prototype.singleMulter.prototype.arrayMulter.prototype.fieldsMulter.prototype.noneMulter.prototype.anyMulter.prototype._makeMiddlewarewrappedFileFilterThese additions aim to enhance the clarity of the codebase and provide better insight into the functionality of the Multer library.
Changes:
Motivation and Context:
Clear documentation helps developers understand how to use the Multer library effectively. This PR aims to improve the usability and maintainability of the code.
Type of Change:
How to Test:
No testing required, as this is purely a documentation update. Review the code for clarity and accuracy of the added comments.